Add section on manual style to Writing Guidelines #10169
Conversation
tetrapod00
force-pushed
the
manual-style-guide
branch
from
4bb3745 to
dd090c2
Compare
Calinou
added
enhancement
area:contributing
This comment was marked as resolved.
This comment was marked as resolved.
tetrapod00
force-pushed
the
manual-style-guide
branch
from
dd090c2 to
ac2a416
Compare
Specifies when to link to the class reference. Specifies how to style various kinds of text.
tetrapod00
force-pushed
the
manual-style-guide
branch
from
ac2a416 to
e7c07d2
Compare
| .. tip:: In most text editors, you can add a vertical guide or "ruler" at 80 | ||
| characters. For example, in Visual Studio Code, you can add the following to | ||
| your ``settings.json`` to add rulers at 80 and 100 characters: | ||
|
|
||
| .. code:: json | ||
|
|
||
| "editor.rulers": [80,100], | ||
|
|
There was a problem hiding this comment.
Not sure about this. We can't list how to do it in all editors. Is VS Code common enough to show favoritism here?
There was a problem hiding this comment.
Yes, I'd say VS Code is pretty much the "default" text editor for most people at this point (especially when no IDE fits the bill).
tetrapod00
changed the title
|
I have noticed that with these additions, the I'd like to continue adding style and content guidelines for a little while (I have a couple more PRs in mind after this one), then address the potential reorganization of these pages. Since these are contributing pages that not much depends on, there should be little harm caused by shuffling content around after it's added, if necessary. |
|
Thanks! Merged. Not cherry-picking this one, as we pretty much expect people to use |
Resolves #5932.
Adds several guidelines on formatting and style for the manual specifically. I documented existing usage as best I could, plus a few opinionated changes that are not yet widespread across the manual, such as linking to project settings.